Investigator API
POST Search TaxMatrix
Overview
Searches the tax matrix.
OperationId: POST Search TaxMatrix
Authorization Method(s): OAuth
Verb: POST
End Point: /api/taxmatrix/search
Example Request
The following is an json request for this operation.
{
"filters": {
"customerUsageType": "07",
"providerType": "80",
"asOfDate": {
"year": "2024",
"month": "12",
"day": 1
},
"releaseNumber": null,
"dateType": "Date"
},
"parameters": {
"pgpis": [
{
"productGroup": "1111",
"productItem": "55"
}
],
"postalCode": null,
"npanxx": null,
"locations": null,
"address": null,
"stateCountyCity": null,
"geocode": "US48113A0004",
"by": "ProductGroupItem",
"skus": []
},
"clientNumber": "ZRERT1234",
"searchCountry": "UnitedStates",
"searchOption": "PostalCode",
"searchType": "TaxabilityMatrix"
}Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Api-version* | api-version | undefined |
Overview
Example Response
The following is an example response you can expect for this operation
{
"results": [
{
"taxabilityMatrixId": 1,
"groupID": "5003",
"groupDescription": "ONE WAY PAGING SERVICE",
"itemID": "007",
"itemDescription": "VERTICAL FEATURES - SERVICE CHARGES (RECURRING)",
"state": "CA",
"county": "KERN",
"city": "BAKERSFIELD",
"otherLocal": "",
"postalCode": "93301",
"plus4": "",
"taxAuthority": "FEDERAL COMMUNICATIONS COMMISSION",
"taxName": "FEDERAL UNIVERSAL SERVICE FUND",
"taxType": "35",
"taxTypeDescription": "Federal Universal Service Fund",
"taxTypeFullDescription": "35 - Federal Universal Service Fund",
"taxCategory": "80",
"taxCategoryDescription": "TELECOMMUNICATIONS AND UTILITIES",
"taxCategoryFullDescription": "80 - TELECOMMUNICATIONS AND UTILITIES",
"taxability": true,
"percentTaxable": 0.12,
"effectiveDate": "1999-01-01T00:00:00",
"customerType": "99",
"providerType": "99",
"geocode": "US0602903526",
"locationId": "1111",
"sales_Use": "Sales"
}
],
"locationResults": [],
"errors": []
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | Matrix search results were successfully returned. |
| 400 | The request could not be processed due to an error |
| 401 | Use doesn't have access to use this API. |
| 404 | Not found records produce an empty response. |